home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / extras / programm / mcode_01 / main / main.txt next >
Text File  |  1995-04-27  |  6KB  |  130 lines
  1. File Description     : Main Document
  2. Author             : Stephen McNabb
  3. Creation Date        : 20th February 1995
  4. Last Updated        : 20th Februray 1995
  5.  
  6. 1. Introduction
  7. ---------------
  8.  
  9.     Welcome to the first, and hopefully not the last, installment
  10. in a series of source code collections based on programming the 68000.
  11. The aim of this collection is to allow programmers to share their tips
  12. and tricks in the hope that more and more Atari users will learn how
  13. to code.
  14.     When I started out, about a year ago, to learn to code I hunted
  15. round the bulletin boards and the Internet for tutorials in 68000 on the
  16. Atari ST, but in vein. So I purchased a book called 'Introducing ATARI ST
  17. machine code', which was written by R.Pearson and S.Hodgson and published
  18. by zzSoft. This was the start of a glorious partnership.
  19.     I would recomend anyone wishing to learn how to write machine code
  20. to pick up a copy of this book, as the included disk comes with all the
  21. neccessary software to get started.
  22.     So after a year, and still no sign of any substantial support in
  23. the public domain world, I decided to start this collection up.
  24.  
  25.  
  26. 2. Aim of the Series
  27. --------------------
  28.     
  29.     My aim is to collect and distribute essential information about
  30. programming the 68000 on the Atari ST. It is not however to teach the basics
  31. of machine code. If you want to learn how to write machine code buy a
  32. suitable book such as the one mentioned above. I have however included some
  33. reference documents which you can use, such as error descriptions and
  34. escape sequences.
  35.     This being the first in the series, all the included code was written
  36. by me. As for the information included, this was collected from a number of
  37. sources. I found that a lot of the time errors seem to slip into most peoples
  38. work so I have done my best to correct these and provided correct information.
  39. But I am not perfect and there could well be mistakes or typos. If you do find
  40. an error then please contact me. My postal and email address are shown at the
  41. bottom of this document.
  42.     You will find that all the included source code is based on simple
  43. text applications and does not deal with windows or graphics. This is because
  44. I never really bothered learning much about these topics. I hope to include
  45. these topics in a later release.
  46.     All the source code is fully commented and, apart from the source in
  47. '\source\basics\', is also supplied in executable form. Feel free to use any
  48. of it in your own work. You will find a file called 'function.s' in the
  49. '\source\' directory. This is a file that I include into most of my work which
  50. has some general functions in the form of subroutines. These include getting
  51. a character from the keyboard and displaying a string on the screen.
  52.     As I said before this series will not teach you how to program in
  53. 68000 but will provide assistance for those just starting of, or even to
  54. those who are a bit more experienced.
  55.     Maybe in the future I will include a tutorial, but that depends on
  56. the amount of response I get.
  57.     All the source code was written and compiled with Hisoft's GenST
  58. Macro Assembler, Version 2.08.
  59.  
  60.  
  61. 3. Contributions
  62. ----------------
  63.  
  64.     To make this series work, I would like any machine code programmers
  65. out there to contribute some work of their own. It doesn't have to be anything
  66. huge or complicated. What I am really looking for is small snippets of code
  67. that can be used in a subroutine of another large program to carry out a simple
  68. task, for example clearing the screen.
  69.     You can contribute any information or code that you think would
  70. be relevant but please you the templates found in the '\source\contrib\'
  71. directory on this disk. And remember that any work you contribute must be
  72. your own and free of copyright so that anyone can use the code in their own
  73. work. Please include a postal or email address with your work so that I, or
  74. others, can contact you.
  75.  
  76.  
  77. 4. Struture of the Disk
  78. -----------------------
  79.  
  80.     You will find this disk sub-divided into directories. Each of the
  81. directories may also contain more sub-divisions. I have tried to lay them
  82. out in such a way that you can find the information easy to find. The layout
  83. is as follows:
  84.  
  85.     \ -+            - Root directory
  86.        |
  87.        |- MAIN\        - Main directory for this series
  88.        |
  89.        |- CONTRIB\        - Information needed for contributing to series
  90.        |
  91.        |- DOCS\        - Reference information about programming
  92.        |
  93.        +- SOURCE\ -+    - Source code and executables
  94.                   |
  95.                   +- BASICS\    - Basic functions eg. clear the screen
  96.                   |
  97.                   |- FUNCTION\    - Subroutines eg. listing a directory
  98.                   |
  99.                   +- GENERAL\    - General functions eg. deleting a file
  100.                   
  101.     Each of the directories has a readme file in it which gives details
  102. about the directory and about the file in it.
  103.  
  104.                   
  105. 5. Nearly Done
  106. --------------
  107.  
  108.     Well I am not going to bore you any longer with details so go ahead
  109. and browse through the disk. I would however like to ask a few things from
  110. you. First, if you find mistakes or typos then please contact me. Second,
  111. distribute it. Third, please contribute to the series so that I have a good
  112. enough reason to carry on with it. And last if you find it of some use to you,
  113. contact me and let me know what you think.
  114.     Well thats all for now. Hope to hear from you soon.
  115.     
  116.     
  117. +===============================+=============================================+
  118. | Stephen 'Hangover' McNabb    + email: u9228616@athmail1.causeway.qub.ac.uk +
  119. | Wannabe Software Engineer    + Post : 30 Sandhurst Drive              +
  120. | Queens University of Belfast    +     Stranmillis                  +
  121. | Langauges: 68000, C, Modula-2    +     Belfast                  +
  122. | Current Project: This series  +     BT9 5AY                  +
  123. | #include <std_disclaimer.h>    +     N.Ireland                  +
  124. +-------------------------------+---------------------------------------------+
  125. +     "We are going to assume a few thing about reality. One, it exists."     +
  126. +            "This is not neccessarily true but it comforts me."          +
  127. +=============================================================================+
  128.  
  129. *** End of File ***
  130.